Configure a Gate Stage

Gate Stage form

Configuration Gate Gate Configurations Gate Configurations view Gate Stage form

The Gate Stage form enables you to add or edit a gate stage for the selected gate configuration. N4 supports one-stage and multistage gates. A multistage gate has multiple gate stages at the ingate and/or at the outgate. For example, if a truck at the ingate is first processed by a gate clerk at one location and then processed again for an inspection at another location, then this is a two-stage or multistage ingate.

You can add multiple gate stages for a gate configuration, but each gate stage must be categorized as either an ingate or an outgate stage. You can also configure the gate stages to have a user manually process the stage, or to have N4 automatically process the gate stage. If you have an inspection before the ingate, you can use the Inspection form (on page 1) to record inspections instead of creating a gate stage for inspections. For more information, see Inspections view (on page 1).

To add or edit a gate stage:

In the Stage Order field, enter the order for the gate stage. Generally, order refers to the physical stages of the gate.

In the Stage ID field, enter an ID that uniquely identifies the gate stage for the gate configuration.

The gate Stage ID field is a case-sensitive field. N4 always saves the Stage ID in lowercase irrespective of the letter case you use while adding a new gate stage.You can specify any user-defined value as the gate stage ID, such as ingate, precheck, callup, or outgate.

If you add a callup stage, you must edit the ROADCALLUP002 (CALLUP_WS_URL) (on page 1) setting in the Settings view for the callup stage.

In the Description field, enter a short description for the gate stage.

For example, you can use this field to specify if it is an ingate stage or an outgate stage.

In the Menu Name field, enter the menu name associated with the gate stage.

You must specify a menu name for each gate stage to enable gate clerks and other users to access the forms defined for the gate stage. N4 uses this to create the submenu under the Operations Gate <Gate Config. ID (on page 1)>.

The menu name specified in this field appears "as is" in the Operations Gate menu and will be used to access the gate transaction type forms associated with the selected gate stage.

From the Stage Type drop-down list, select the gate stage type based on the location:

In-gate Stage: If the gate stage is located at the ingate.
Out-gate Stage: If the gate stage is located at the outgate.

If you do not select a gate stage type, the stage is treated as an ingate stage, by default.

Click Save.

Use the above steps to add all the gate stages (ingate and outgate) for the selected gate configuration.

The gate stages added for a gate configuration display in the left pane of the Gate Configurations view (on page 1). If the gate stages are not visible, click the plus sign next to the gate configuration entity to expand the tree.

Gate Stage Privileges

When you add a gate stage, N4 automatically creates a corresponding privilege for the gate stage. For example, if you create a gate ABC GATE, N4 creates a gate privilege by the name Gate: ABC GATE Access. To enable an authorized user to access the gate stage menu option from the Operations Gate menu, assign the gate stage privilege to the appropriate user role. For more information on editing roles, see Role form.

Notes

N4 forces all stage IDs to be lowercase regardless of what you enter in the Stage ID field. Since the Stage ID field is for internal use only, N4 changes it to a form that is consistent with what the other components, such as XPS, expect. This value of the Stage ID field is used to display the name of the stage in the Gate Configuration view and in the Gate Stages Allowed field in the Gate Stage form. It is not used to display the menu or the gate stage tab in the Operations Gate menu. To specify the menu name, use the Menu Name field.
If you add a new Stage ID or rename an existing Stage ID, you must restart N4 before accessing the Operations Gate menu. All other configuration changes only require closing and reopening the tabs corresponding to the changed gate stage.
If you edit or change the name of an existing gate stage, N4 adds a new privilege with the new name. You must add the new privilege to the appropriate user role.
In addition to assigning the new privileges to the appropriate user roles, you must re-generate the licenses for your facility. You must use Administration Security Licenses Licenses view Actions Reload Licenses from Database to reload the licenses after updating any dynamic menus, such as the gate stage menus.

The following table lists the optional fields in the Gate Stage form:

Field Label	Description
Is Auto Stage	Select this check box to indicate that the stage is automated and does not require user input to process. When N4 processes a truck visit at an automated gate stage, it processes all the gate transactions that are associated with the truck visit for trucks that have been sent to the gate stage. It also completes the gate stage processing, similar to when a user clicks Proceed to Next Stage in a gate form, so that the truck visit is able to move to the next gate stage.
Transaction Not Mandatory	Select this check box to enable the Proceed To Next Stage button in the ingate Gate form so that the gate clerk can create a truck visit and process the transaction to the next stage without specifying the transaction type and other associated details in the Transaction Entry area. This option facilitates terminals that deliver general cargo on an ad hoc basis where the trucker enters the terminal providing bare minimal information, to pick up break-bulk cargo. With the Transaction Not Mandatory option, the gate clerk can process the transaction with details like the trucking company and license. The trucker can proceed to the yard to pick up cargo without providing details like the bill of lading or delivery order, which are otherwise considered mandatory during regular gate transactions. This check box is editable only if you are configuring the Ingate Gate Stage and appears grayed out for an Outgate Gate Stage.
Truck Visit Required	Select this check box to require an existing truck visit to process transactions at this stage. Not selecting this check box allows N4 to create a truck visit at this stage even if it is not the first gate stage.
Check If All Done	Select this check box if you want N4 to automatically process the truck visit for the selected gate stage. When you process a truck visit at this stage, after you process a gate transaction, N4 checks if it is also the last gate transaction for the truck visit at the selected gate stage. After you have processed the last gate transaction, it automatically completes the gate stage processing, similar to when a user clicks Proceed to Next Stage in a gate form, so that the truck visit is able to move to the next gate stage. If you have a single stage gate, do not select this check box. For example, if you do not have an ingate stage for containers delivered out the yard, do not select the Check If All Done check box for the outgate stage because N4 cannot determine whether there are any pending gate transaction when you perform the first gate transaction. In this case, the gate clerk must click Proceed to Next Stage in a gate form, to complete the truck visit.
Poll Next Truck	Select this check box if you want to turn on polling and enable N4 to retrieve scan details from the cache. If you select this check box, N4 uses the lane scan and scale data to create or update a gate transaction. N4 starts polling for data in the cache when a user opens the <GateStage> tab in the Operations Gate menu for the selected gate stage. If polling is enabled, N4 automatically fills in the scanned data in the <GateStage> tab for the associated gate stage only if the <GateStage> tab is open and undocked. The <GateStage> tab cannot be minimized or closed. For example, if a gate clerk is working both ingate and outgate stages, those respective <GateStage> tabs must be kept open and undocked. In this case, if N4 retrieves scanned data from the ingate, N4 automatically fills in the ingate <GateStage> tab and brings it into focus. At the ingate, if the gate transaction type is not known during a truck scan, N4 creates a gate transaction with the transaction type Unknown and status INCOMPLETE. However, if a truck visit already has gate transactions from a previous gate stage, N4 only creates new Unknown gate transactions when the scanned container does not match the existing gate transactions. At the outgate, if a scanned container does not match the container in: A single delivery gate transaction of one or more delivery gate transactions associated with the truck visit, N4 updates the container number with the scanned container ID. More than one of the delivery gate transactions associated with the truck visit, N4 clears the container numbers in the mismatched gate transactions. In this case, the gate clerk must manually enter and verify the container numbers. In all of the above cases, after polling, N4 displays a warning message with all mismatched container numbers. If the selected gate stage includes the RejectContainerSubstitution (on page 1) business task, N4 does not update any container numbers and instead displays an error message. To update the transaction type for a gate transaction, double-click the gate transaction on the All Transactions tab and select the appropriate gate transaction type. If you select the Poll Next Truck check box, N4 displays a Reset button in the <GateStage> tab (on page 1). The Reset button clears the fields in the <GateStage> tab and retrieves the latest data from the cache. This is different from the Cancel/Suspend Stage button, which clears the fields and the scanned data in the cache. To hide the Cancel/Suspend Stage button for stages using polling, set the ROADGATE017 (HIDE_CANCEL_SUSPEND_STAGE_BUTTON) (on page 1) setting to true. In addition, N4 displays a Stop Polling Timer button in the <GateStage> tab. The Stop Polling Timer button stops polling to enable you to manually process the gate transactions for a truck visit. To start polling again, click the Reset button.
Poll Truck Interval	The frequency, in seconds, at which N4 polls for scanned data in the cache when no data is found. To enable this field, select the Poll Next Truck check box. When polling is enabled, N4 displays asterisks in the lower left corner of the <GateStage> tab to indicate each second that passes during the Poll Truck Interval. For example, if you enter 5 in the Poll Truck Interval field and no scanned data is found, N4 displays one asterisk in the <GateStage> tab for each second that passes until five asterisks display. At that time, N4 polls again and if no data is found repeats the process. If you do not enter a value in this field, N4 uses the default interval of 15 seconds to poll for trucks.
Extra Time (mins)	The additional time a truck may spend at a gate stage before N4 closes the truck visit per the auto-close background job.
Time Allowed (mins)	The time a truck is allowed at this gate stage. This time is added to the age of the truck visit when N4 considers closing it via the auto-close background job. This field, together with the Extra Time field, lets you configure different active visit thresholds for each gate stage of a truck. Because the gate stages or work flow for each truck visit can vary, some trucks that go through more gate stages, such as a callup stage, can spend more time in the terminal and exceed the active truck visit threshold. If the active truck visit threshold is exceeded, the truck visit is no longer active and the truck is not able to exit the terminal without trouble. For example, if the ROADGATE004 (ACTIVE_TRUCK_VISIT) (on page 1) setting is 4h and the gate configuration has the following gate stages with these fields set as follows: Pregate: Not set Staging: Extra Time = 3h Ingate: Not set Yard: Not set Swap: Extra Time = 30min and Time Allowed = 30min Outgate: Not set Then a truck visit: By default, before reaching the Staging, has a total active time = 4h. This is also true if the Extra Time or Time Allowed fields are NOT set. That spends 2h in Staging has a total active time of 6h (4h + 2h). That spends 4h in Staging has a total active time = 7h (4h + 3h). The maximum extra time added is 3h and because Time Allowed is not set for Staging, the truck visit does not expire while it is in the Staging stage. That skips Staging and spends 20 minutes at the Swap stage has a total active time of 4h 20min (4h + 20min). That spends more than 30 minutes at the Swap stage is expired, regardless of whether it is within the 4 hours or not. That spends 1h at Staging and 20min at Swap, has a total active time of 5h 20min (4h + 1h + 20min).
Allow Edit Completed Transactions	Select this check box if this gate stage is acting as a "fix-it" stage, meaning you can edit active and completed truck visits and their associated transactions at this stage. Do not select this for the first gate stage where the truck visit/transactions do not exist yet. If you select the Allow Edit Completed Transactions check box, then N4 does not include this gate stage in the dynamic workflow. If the Allow Edit Completed Transactions check box is selected, you can only edit transactions with a next stage ID equal to the Allow Stage Id, unless you also select the Allow Any Stage check box. Selecting the Allow Any Stage and Allow Edit Completed Transactions check boxes enables you to edit any transaction without forcing all other transactions, associated with the truck visit, through this gate stage. Selecting the Allow Edit Completed Transactions check box does not allow editing status, stage ID, or next stage ID. In addition, you cannot edit canceled or closed visits and transactions.
Exchange Lane Assignment Booth	If this gate stage is a workflow stage where a truck goes to get an exchange lane assignment without impacting the actual gate workflow. The purpose of this gate stage is just to assign exchange lanes to gate transactions. If the Exchange Lane Assignment Booth check box is selected, N4 records this gate stage as SlotBooth in the Stages tab (on page 1). However, this is not a next stage for any gate stages. Therefore, N4 does not assign this gate stage as a next stage in a gate transaction.
Next Stage (No Moves)	Specifies the next gate stage for a truck if no gate transactions are associated with the truck visit at the selected gate stage. If you send trucks at the outgate back to the yard to return or get another container, make sure to set the Next Stage (No Moves) for the yard gate stage to the outgate stage. To process a truck visit without any gate transactions, you must configure the gate stage with only truck visit forms and no trans type forms.
Assignment of Pickups	For automated gate stages, select the method of adding delivery appointments associated with the truck visit appointment provided in the process-truck API call at this gate stage: No Assignment: N4 does not search for available same day pick-up appointments Automatic Assignment: N4 automatically assigns appointments for up to the maximum TEU Prompt for Assignment: N4 returns a list of appointments in the <appointment> elements in the process-truck response.
Open Barrier on Trouble	For automated gate stages, select the check box to enable the process-truck API to open the gate arm for trouble transactions.
Supports Callup	For staging areas, select this check box to enable truck callup into a staging area. By selecting this check box, you mark this stage as the 'staging' stage. If the check box is selected, N4 submits the truck visit when you select the Save Transaction button at this gate stage.
Include Appointment Tab	For gate stages that use appointments to process gate transactions, select if and how the Appointments tab displays in the <GateStage> tab (on page 1) for a gate clerk: editable: N4 displays the Appointments tab and allows a user to select a transaction appointment to use for gate transaction processing. In this case, a user can select an appointment in the Appointments tab instead of manually entering the appointment number. viewOnly: N4 displays the Appointments tab but does not allow a user to select an appointment. hidden: N4 does not display the Appointments tab. none: N4 does not display the Appointments tab.
Filter for Appointments Tab	If the Include Appointment Tab drop-down list is set to editable or viewOnly, you can select a filter to determine how data is displayed in the Appointments tab in the <GateStage> tab (on page 1) for a gate clerk. The drop-down lists displays filters that exist in the Appointments view (on page 1). If you select a filter, it determines the columns and data that display in the Appointments tab. If the selected filter contains columns in the Appointments view that are not available in the Appointments tab, such as the Slot Reused column, these columns do not display in the Appointments tab. If nothing is selected, N4 displays the default columns and all available appointments for the truck visit in the Appointments tab.
Include Groups Tab	For gate stages that use groups (on page 1) to process deliver gate transactions, select if and how the Delivery Groups tab displays in the <GateStage> tab (on page 1) for a gate clerk: editable: N4 displays the Delivery Groups tab and allows a user to select a group to use for gate transaction processing. viewOnly: N4 displays the Delivery Groups tab but does not allow a user to select an appointment. hidden: N4 does not display the Delivery Groups tab. none: N4 does not display the Delivery Groups tab. N4 only displays groups with one or more associated containers. In addition, if a group has a start or end time, N4 only displays the group if the current time falls between the start and end time.
Filter for Cargo Lots Form	Obsolete Field. This is no longer used.
Stage Visible in CAP	Select this check box if you want to make the stage available in CAP under the Gate menu. You can select this check box for only one gate stage in your gate configuration. If this check box is selected, when the CAP user logs in at the facility level, the gate stage is displayed under the Gate menu. The label of the menu item is displayed using the following format: configured gate ID: gate description - stage ID. In CAP, the gate stage menu item is displayed below the Truck Visit Appointments menu item.
Auto populate truck details in allowed stages	Select this check box if you want the truck details to be populated in all the gate stages included in the Gate Stage form. If this check box is selected, and when the user turns on ‘Polling’ and posts the process-truck and record-scan API, N4 populates the truck details in all the allowed gate stages included in the Gate Stage form.
Gate Stages Allowed	In the Excluded field, select the gate stages that are allowed to feed into this gate stage. Then use the arrow buttons to move the allowed gate stages to the Included field. For example, after a truck picks up an empty container from the yard, the next stage would be the outgate. However, you may want to allow the truck to stop at an empty storage office, where empties are stored, if the driver is not satisfied with the empty container received from the yard. The empty storage office is an alternate stage for the outgate, where the truck would normally go with a satisfactory empty container. Therefore, when configuring the empty storage office gate stage, you must specify the outgate stage in the Allow Stage Id field. Similarly, if you want to process the outgate for a truck visit directly after ingate by skipping the yard stage for any reason, then you may have to edit this field and include 'Yard' in it. The Gate Stages Allowed panel is validated by the CheckTruckOKAtStage (on page 1) business task.